package demo.java.nio.channels;

import org.junit.Test;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.SelectableChannel;
import java.nio.channels.SelectionKey;
import java.nio.channels.Selector;
import java.nio.channels.ServerSocketChannel;
import java.nio.channels.SocketChannel;
import java.util.Iterator;
import java.util.Set;

/**
 * Java的Selector是一个重要的NIO组件，用于监控多个Channel的IO事件。并能够知晓通道是否为诸如读写事件做好准备的组件。
 * 这样，一个单独的线程可以管理多个channel，从而管理多个网络连接。
 * Selector是Java NIO中的一个核心组件，通过它可以实现单线程管理多个Channel，大大提高了程序的效率。
 * 它是基于操作系统的多路复用功能实现的，在Linux上底层使用epoll，在Windows上使用select。
 * 理解和正确使用Selector是开发高性能网络应用的关键。
 * <p><br>
 * Selector的优点
 * <li>能够监控多个Channel
 * <li>只需要一个线程就可以管理多个Channel
 * <li>减少线程上下文切换开销
 * <li>适合高并发、低延迟的网络应用
 * <p><br>
 * 实际应用场景
 * <li>网络服务器（如Netty）
 * <li>聊天服务器
 * <li>代理服务器
 * <li>文件服务器
 */
public class SelectorDemo {

    private static void handleRead(SelectionKey key) throws IOException {
        SocketChannel clientSocketChannel = (SocketChannel) key.channel();
        ByteBuffer buffer = ByteBuffer.allocate(1024);
        clientSocketChannel.read(buffer);
        buffer.flip();
        // 处理读取的数据
    }

    /**
     * @throws IOException
     */
    @Test
    public void testSelector() throws IOException {
        // 创建Selector,新的selector是通过调用系统默认的SelectorProvider对象的openSelector方法而创建的。
        Selector selector = Selector.open();

        // 创建Channel并注册到Selector。
        ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
        serverSocketChannel.bind(new InetSocketAddress("localhost", 8080));
        // 必须设置为非阻塞模式。与Selector一起使用时，Channel必须处于非阻塞模式，
        // 所以不能将FileChannel和Selector一起使用，因为FileChannel不能切换到非阻塞模式。而socketChannel都可以。
        serverSocketChannel.configureBlocking(false);
        // ServerSocketChannel 只会在选择器上注册一个，其感兴趣的操作只有ACCEPT，表示其只关心客户端的连接请求
        SelectionKey selectionKey = serverSocketChannel.register(selector, SelectionKey.OP_ACCEPT);

        while (true) {
            // Selector允许单线程处理多个Channel。使用Selector，首先得向Selector注册 Channel，然后调用它的select()。
            // 该方法会一直阻塞，直到某个注册的Channel有事件就绪。一旦这个方法返回，线程就可以处理这些事件，事件的例子如新连接 进来，数据接收等。
            selector.select();
            Set<SelectionKey> selectedKeys = selector.selectedKeys();
            Iterator<SelectionKey> iterator = selectedKeys.iterator();

            while (iterator.hasNext()) {
                SelectionKey key = iterator.next();

                if (key.isAcceptable()) {
                    SocketChannel clientSocketChannel = serverSocketChannel.accept();
                    clientSocketChannel.configureBlocking(false);
                    // SocketChannel，通常会注册多个，因为一个server通常会接受到多个client的请求，就有对应数量的SocketChannel。
                    // SocketChannel 感兴趣的操作是CONNECT、READ、WRITE，因为其要与server建立连接，也需要进行读、写数据。
                    clientSocketChannel.register(selector, SelectionKey.OP_READ);
                }

                if (key.isReadable()) {
                    handleRead(key);
                }
                // 处理完SelectionKey后要将其移除,避免重复处理
                iterator.remove();
            }
        }
    }

    /**
     * SelectionKey的事件类型
     *
     * <li>Read 一个有数据可读的通道可以说是“读就绪”。
     * <li>Write 等待写数据的通道可以说是“写就绪”。
     * <li>Connect 通道触发了一个事件意思是该事件已经就绪。所以，某个channel成功连接到另一个服务器称为“连接就绪”。
     * <li>Accept 一个server socket channel准备好接收新进入的连接称为“接收就绪”。
     * <p><br/>
     * 这四种事件用SelectionKey的四个常量来表示：
     */
    public void selectionKeyEvent() {
        int op;
        op = SelectionKey.OP_READ;    // 读事件(1)
        op = SelectionKey.OP_WRITE;   // 写事件(4)
        op = SelectionKey.OP_CONNECT; // 连接事件(8)
        op = SelectionKey.OP_ACCEPT;  // 接受事件(16)

        // 若对不止一种事件感兴趣，那么可以用“|”操作符将常量连接
        int interestSet = SelectionKey.OP_READ | SelectionKey.OP_WRITE; // 读写事件
        System.err.println(interestSet);
    }


    /**
     * SelectionKey，当向Selector注册Channel时，register()方法会返回一个SelectionKey对象。这个对象包含了一些你感兴趣的属性：
     *
     * <li>interest集合: interest集合是你所选择的感兴趣的事件集合。
     * <li>ready集合: ready 集合是通道已经准备就绪的操作的集合。在一次选择(Selection)之后，你会首先访问这个ready set。
     * <li>Channel:Channel channel = selectionKey.channel();
     * <li>Selector: Selector selector = selectionKey.selector();
     * <li>附加的对象（可选） 可以将一个对象或者更多信息附着到SelectionKey上，这样就能方便的识别某个给定的通道。
     * <p>
     */
    public void demoSelectionKey() throws IOException {
        SelectableChannel selectableChannel = ServerSocketChannel.open();
        Selector selector = Selector.open();
        // 附加对象
        Object theObject = new Object();
        SelectionKey selectionKey = selectableChannel.register(selector, SelectionKey.OP_ACCEPT, theObject);
        // interest集合，可以像这样用“位与”操作interest集合和给定的SelectionKey常量，确定某个确定的事件是否在interest 集合中。
        int interestSet = selectionKey.interestOps();
        boolean isInterestedInAccept = (interestSet & SelectionKey.OP_ACCEPT) == SelectionKey.OP_ACCEPT;
        boolean isInterestedInConnect = (interestSet & SelectionKey.OP_CONNECT) == SelectionKey.OP_CONNECT;
        boolean isInterestedInRead = (interestSet & SelectionKey.OP_READ) == SelectionKey.OP_READ;
        boolean isInterestedInWrite = (interestSet & SelectionKey.OP_WRITE) == SelectionKey.OP_WRITE;
        //可以用像检测interest集合那样的方法，来检测channel中什么事件或操作已经就绪。也可使用以下四个方法，它们都会返回一个布尔类型
        int readySet = selectionKey.readyOps();
        boolean isAcceptable = selectionKey.isAcceptable();
        boolean isConnectable = selectionKey.isConnectable();
        boolean isReadable = selectionKey.isReadable();
        boolean isWritable = selectionKey.isWritable();
        // SelectionKey.channel() 返回的channel需要转型成你要处理的类型
        SelectableChannel channel = selectionKey.channel();
        SocketChannel socketChannel = (SocketChannel) channel;
        // 返回注册绑定的 Selector
        Selector theSelector = selectionKey.selector();
        boolean isSameSelector = theSelector == selector;
        // 附加给定对象到该key，例如，可以附加 与通道一起使用的Buffer，或是包含聚集数据的某个对象
        selectionKey.attach(theObject);
        // 获取附加对象
        Object attachedObj = selectionKey.attachment();

    }

    /**
     * 一旦向Selector注册了一或多个通道，就可以调用几个重载的select()方法。
     * 这些方法返回你所感兴趣的事件（如连接、接受、读或写）已经准备就绪的那些通道。
     * 换句话说，如果你对“读就绪”的通道感兴趣，select()方法会返回读事件已经就绪的那些通道。 下面是select()方法：
     * <li>int select() : 阻塞到至少有一个通道在你注册的事件上就绪了。
     * <li>int select(long timeout) :和select()一样，除了最长会阻塞timeout毫秒(参数)。
     * <li>int selectNow(): 不会阻塞，不管什么通道就绪都立刻返回 select()方法返回的int值表示有多少通道已经就绪。亦即，自上次调用select()方法后有多少通道变成就绪状态。
     * <p><br/>
     * select()的返回值不是已就绪的channel的总数，而是从上一个select()调用之后，进入就绪态的channel的数量。
     * 之前的调用中就绪的，并在本次调用中仍就绪的channel不会被计入。那些在前一次调用中已就绪，但已不再处于就绪态的通道也不会计入。
     * 这些channel可能仍然在SelectionKey集合中，但不会被计入返回值中，所以返回值可能是0。
     */
    public void select(Selector selector) throws IOException {
        int readyChannels = selector.select();           // 阻塞直到有事件就绪
        int readyChannels2 = selector.select(1000);      // 最多阻塞1000毫秒
        int readyChannels3 = selector.selectNow();       // 非阻塞,立即返回

        // 获取就绪的SelectionKey集合。
        // 当向Selector注册Channel时，Channel.register()方法会返回一个SelectionKey 对象。这个对象代表了注册到该Selector的Channel。
        // 可通过SelectionKey的selectedKeySet()方法访问这些对象。
        Set<SelectionKey> selectedKeys = selector.selectedKeys();

        // 唤醒阻塞的select()
        selector.wakeup();

        // 关闭selector
        selector.close();
    }

    /**
     * 某个线程调用 select() 后阻塞了，即使没有channel已就绪，也有办法让其从select()返回。
     * 只需通过其它线程在第一个线程调用select()方法的那个对象上调用Selector.wakeup()。阻塞在select()方法上的线程会立马返回。
     * <p>
     * 若有其它线程调用了wakeup()，但当前没有线程阻塞在select()，下个调用select()方法的线程会立即“醒来（wake up）”。
     * <p>
     * 作用总结：
     * <li>解除阻塞在Selector.select()/select(long)上的线程，立即返回
     * <li>两次成功的select之间多次调用wakeup等价于一次调用
     * <li>如果当前没有阻塞在select上，则本次wakeup调用将作用于下一次select操作
     */
    public void wakeup(Selector selector) {
        Selector thisSelector = selector.wakeup();
    }

    /**
     * 用完Selector后调用其close()会关闭该Selector，且使注册到该Selector上的所有SelectionKey实例无效。但channel本身并不会关闭。
     */
    public void close(Selector selector) throws IOException {
        // 关闭selector
        selector.close();
    }


    void selectorDemo(SocketChannel socketChannel) throws IOException {
        Selector selector = Selector.open();
        /**
         * 向Selector注册通道:与Selector一起使用时，Channel必须处于非阻塞模式下。这意味着不能将FileChannel与Selector一起使用，因为FileChannel不能切换到非阻塞模式。而套接字通道都可以。
         */
        socketChannel.configureBlocking(false);
        /**
         * 注意register()方法的第二个参数。这是一个“interest集合”，意思是在通过Selector监听Channel时对什么事件感兴趣。
         * 可以监听四种不同类型的事件：Connect\Accept\Read\Write。 通道触发了一个事件意思是该事件已经就绪。 所以，某个channel成功连接到另一个服务器称为“连接就绪”。 一个server
         * socket channel准备好接收新进入的连接称为“接收就绪”。 一个有数据可读的通道可以说是“读就绪”。等待写数据的通道可以说是“写就绪”。
         *
         * 这四种事件用SelectionKey的四个常量来表示：SelectionKey.OP_CONNECT\SelectionKey.OP_ACCEPT\SelectionKey.OP_READ\SelectionKey.OP_WRITE。
         * 如果你对不止一种事件感兴趣，那么可以用“位或”操作符将常量连接起来，如下：int interestSet = SelectionKey.OP_READ | SelectionKey.OP_WRITE;
         *
         */
        SelectionKey selectionKey = socketChannel.register(selector, SelectionKey.OP_READ);


        int readyChannels = selector.selectNow();
        if (readyChannels > 0) {
            /**
             * 一旦调用了select()方法，并且返回值表明有一个或更多个通道就绪了，然后可以通过调用selector的selectedKeys()方法，访问“已选择键集（selected key set）”中的就绪通道。
             * 当像Selector注册Channel时，Channel.register()方法会返回一个SelectionKey
             * 对象。这个对象代表了注册到该Selector的通道。可以通过SelectionKey的selectedKeySet()方法访问这些对象
             */
            Set<SelectionKey> selectedKeys = selector.selectedKeys();
            // 可以遍历这个已选择的键集合来访问就绪的通道。
            for (SelectionKey key : selectedKeys) {
                if (key.isAcceptable()) {
                    SelectableChannel selectableChannel = key.channel();
                    // a connection was accepted by a ServerSocketChannel.
                } else if (key.isConnectable()) {
                    // a connection was established with a remote server.
                } else if (key.isReadable()) {
                    // a channel is ready for reading
                } else if (key.isWritable()) {
                    // a channel is ready for writing
                }
                selectedKeys.remove(key);
            }
        }
    }
}
